Skip to content

Modify node settings including cluster assignment and operational state

Request

Update a node (appliance or agent)

Requires nodes::manage permission.

Security
JWTAuthorizer
Path
nodeIDstringrequired

Node ID

Bodyapplication/json

Node updates

clusterstring

Cluster FQDN - requires nodes::cluster permission to modify. If set to null, the node will be removed from the cluster.

Example:"mycluster.trustgrid.io"
statestring

Node state

Enum:"ACTIVE""INACTIVE"
curl -i -X PUT \
  'https://apidocs.trustgrid.io/_mock/node/{nodeID}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "cluster": "mycluster.trustgrid.io",
    "state": "ACTIVE"
  }'

Responses

OK